<html><head><title>ProgressBarGadget</title></head>
<body bgcolor="#FFFFDF" link="#009999" vlink="#006666" alink="#006666">
<font face="Arial" size="2"><p align="center"><b><font size="4">ProgressBarGadget()</font></b></p>
<p><b>Syntax</b></p><blockquote>
Result = <font color="#006666"><b>ProgressBarGadget</b></font>(#Gadget, x, y, Width, Height, Minimum, Maximum [, Flags])</blockquote>

</blockquote>
<b>Description</b><br><blockquote>

Creates a ProgressBar gadget in the current GadgetList. 

</blockquote><p><b>Parameters</b></p><blockquote>
<style type="text/css">
table.parameters { border-spacing: 0px; border-style: none; border-collapse: collapse; }
table.parameters td { border-width: 1px; padding: 6px; border-style: solid; border-color: gray; vertical-align: top; font-family:Arial; font-size:10pt; }
</style>
<table width="90%" class="parameters">
<tr><td width="10%"><i>#Gadget</i></td>
<td width="90%"> 
A number to identify the new gadget. <a href="../reference/purebasic_objects.html">#PB_Any</a> can 
be used to auto-generate this number. 

</td></tr>
<tr><td><i>x, y, Width, Height</i></td>
<td> 
The position and dimensions of the new gadget. 

</td></tr>
<tr><td><i>Minimum, Maximum</i></td>
<td> 
The minimum and maximum values that the progress bar can take. 

</td></tr>
<tr><td><i>Flags (optional)</i></td>
<td> 
Flags to modify the gadget behavior. It can be a combination of the following values: 
<pre><font face="Courier New, Courier, mono"size="2">  <font color="#924B72">#PB_ProgressBar_Smooth</font>   : The progress bar is smooth instead of using blocks
                             (Note: On Windows XP with enabled skins and on OS X, this flag has no effect).
  <font color="#924B72">#PB_ProgressBar_Vertical</font> : The progress bar is in vertical mode.
</font></pre>

</td></tr>
</table>
</blockquote><p><b>Return value</b></p><blockquote>

Returns nonzero on success and zero on failure. If <font color="#924B72">#PB_Any</font> was used as the #Gadget parameter 
then the return-value is the auto-generated gadget number on success. 

</blockquote><p><b>Remarks</b></p><blockquote>

A 'mini help' can be added to this gadget using <a href="gadgettooltip.html">GadgetToolTip()</a>. 
<br>
<br>
The following functions can be used to act on the gadget: 
<br>
<br>
- <a href="setgadgetstate.html">SetGadgetState()</a>: Change progress bar value. 
<br>
- <a href="getgadgetstate.html">GetGadgetState()</a>: Get the current progress bar value. 
<br>
- <a href="setgadgetattribute.html">SetGadgetAttribute()</a>: With the following attributes: 
<pre><font face="Courier New, Courier, mono"size="2">  <font color="#924B72">#PB_ProgressBar_Minimum</font>   : Changes the minimum value.
  <font color="#924B72">#PB_ProgressBar_Maximum</font>   : Changes the maximum value.
</font></pre>

- <a href="getgadgetattribute.html">GetGadgetAttribute()</a>: With the following attributes: 
<pre><font face="Courier New, Courier, mono"size="2">  <font color="#924B72">#PB_ProgressBar_Minimum</font>   : Returns the minimum value.
  <font color="#924B72">#PB_ProgressBar_Maximum</font>   : Returns the maximum value.
</font></pre>

This gadget supports the <a href="setgadgetcolor.html">SetGadgetColor()</a> and <a href="getgadgetcolor.html">GetGadgetColor()</a> functions with 
the following values as 'ColorType'. (Note: Windows only. On Windows XP with enabled skins, this coloring has no effect.) 
<pre><font face="Courier New, Courier, mono"size="2">  <font color="#924B72">#PB_Gadget_FrontColor</font>: Progressbarcolor
  <font color="#924B72">#PB_Gadget_BackColor</font> : Backgroundcolor
</font></pre>

</blockquote><p><b>Example</b></p><blockquote>

<pre><font face="Courier New, Courier, mono"size="2">  <b><font color="#006666">If</font></b> <font color="#006666">OpenWindow</font>(0, 0, 0, 320, 160, "ProgressBarGadget", <font color="#924B72">#PB_Window_SystemMenu</font> | <font color="#924B72">#PB_Window_ScreenCentered</font>)
<font color="#006666">    TextGadget       </font>(3,  10, 10, 250,  20, "ProgressBar Standard  (50/100)", <font color="#924B72">#PB_Text_Center</font>)
<font color="#006666">    ProgressBarGadget</font>(0,  10, 30, 250,  30, 0, 100)
<font color="#006666">    SetGadgetState   </font>(0, 50)   <font color="#006666">;  set 1st progressbar (ID = 0) to 50 of 100</font>
<font color="#006666">    TextGadget       </font>(4,  10, 70, 250,  20, "ProgressBar Smooth  (50/200)", <font color="#924B72">#PB_Text_Center</font>)
<font color="#006666">    ProgressBarGadget</font>(1,  10, 90, 250,  30, 0, 200, <font color="#924B72">#PB_ProgressBar_Smooth</font>)
<font color="#006666">    SetGadgetState   </font>(1, 50)   <font color="#006666">;  set 2nd progressbar (ID = 1) to 50 of 200</font>
<font color="#006666">    TextGadget       </font>(5, 100,135, 200,  20, "ProgressBar Vertical  (100/300)", <font color="#924B72">#PB_Text_Right</font>)
<font color="#006666">    ProgressBarGadget</font>(2, 270, 10,  30, 120, 0, 300, <font color="#924B72">#PB_ProgressBar_Vertical</font>)
<font color="#006666">    SetGadgetState   </font>(2, 100)   <font color="#006666">; set 3rd progressbar (ID = 2) to 100 of 300</font>
    <b><font color="#006666">Repeat</font></b> : <b><font color="#006666">Until</font></b> <font color="#006666">WaitWindowEvent</font>()=<font color="#924B72">#PB_Event_CloseWindow</font>
  <b><font color="#006666">EndIf</font></b>
</font></pre>
<br>
<p><img src="../HelpPictures/progressbargadget.png"></p>

</blockquote><p><b>See Also</b></p><blockquote>

<a href="getgadgetstate.html">GetGadgetState()</a>, <a href="setgadgetstate.html">SetGadgetState()</a>, <a href="getgadgetattribute.html">GetGadgetAttribute()</a>, <a href="setgadgetattribute.html">SetGadgetAttribute()</a>, <a href="getgadgetcolor.html">GetGadgetColor()</a>, <a href="setgadgetcolor.html">SetGadgetColor()</a> 

</Blockquote><p><b>Supported OS </b><Blockquote>All</Blockquote></p><center><- <a href=panelgadget.html>PanelGadget()</a> - <a href=index.html>Gadget Index</a> - <a href=removegadgetcolumn.html>RemoveGadgetColumn()</a> ->

</body></html>